package com.zyf.project.binaryproto.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * <h1>数据契约——枚举类型</h1>
 * <p>作用于类之上</p>
 *
 * @author Zhou Yifan
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface EnumContract {

    /**
     * 类型编号
     *
     * @return 编号
     */
    int code();

    /**
     * 名字
     *
     * @return 名字
     */
    String name() default "";

    /**
     * 描述
     *
     * @return 描述
     */
    String description() default "";
}
